iT邦幫忙

第 11 屆 iThome 鐵人賽

DAY 23
0
Software Development

模組化設計系列 第 23

Day23 - 模組目錄結構設計

  • 分享至 

  • xImage
  •  
- bin / script
- doc
- example
- src / lib
- dist / build
- test

bin 目錄

  • 集中放一些執行檔
  • 有些模組會取名叫 scripts 資料夾

doc 目錄

  • 通常放一些編譯過的 html,然後在掛上 github page 的設定,讓使用者可以直接透過瀏覽器查看。
  • 有時候是放 markdown 格式的文件

examples 目錄

  • 有時候千言萬語不如給一個範例,所以有提供程式範例的模組是非常加分的。

lib 目錄

.
├── index.js
└── lib
    ├── a.js
    ├── b.js
    └── index.js

如果你把所有檔案都放在跟目錄下會非常的混亂,所以常見的情況是跟目錄只放 index.js,其他函示都收納在 lib 資料夾裡面。

如果你的原始碼是需要編譯的話(例如 ts 檔),那通常會取名叫 src 資料夾。

dist 目錄

存放原始碼編譯後的檔案,有時候會取名叫 build 資料夾,也很常見。

test 目錄

基本上我在挑選外部模組的時候,如果是沒寫測試程式的模組,我根本不敢使用,所以這裡是放置我們測試程式的地方。

參考的模組


上一篇
Day22 - Git Submodule
下一篇
Day24 - 模組的 README 設計
系列文
模組化設計30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言